sqlx4k-postgres/io.github.smyrgeorge.sqlx4k.postgres/[native]PostgreSQL

PostgreSQL

class PostgreSQL(url: String, username: String, password: String, options: Driver.Pool.Options = Driver.Pool.Options()) : IPostgresSQL

PostgreSQL class provides mechanisms to interact with a PostgreSQL database. It implements Driver, Driver.Pool, and Driver.Transactional interfaces, offering functionalities such as connection pooling, executing queries, fetching data, and handling transactions.

The URL scheme designator can be either postgresql:// or postgres://. Each of the URL parts is optional.

postgresql:// postgresql://localhost postgresql://localhost:5433 postgresql://localhost/mydb

Parameters

url

The URL of the PostgreSQL database to connect to.

username

The username used for authentication.

password

The password used for authentication.

options

Optional pool configuration, defaulting to Driver.Pool.Options.

Constructors

PostgreSQL

constructor(url: String, username: String, password: String, options: Driver.Pool.Options = Driver.Pool.Options())

Types

Companion

object Companion

class Tx(rt: <Error class: unknown class><out <Error class: unknown class>>, tx: <Error class: unknown class><out <Error class: unknown class>>) : Transaction

Represents a database transaction, providing methods to perform commit, rollback, and query execution operations within the transaction's context.

Functions

begin

open suspend override fun begin(): Result<Transaction>

open suspend override fun close(): Result<Unit>

execute

open suspend override fun execute(statement: Statement): Result<Long>

open suspend override fun execute(sql: String): Result<Long>

fetchAll

open suspend fun <T> fetchAll(sql: String, rowMapper: RowMapper<T>): Result<List<T>>

open suspend override fun fetchAll(statement: Statement): Result<ResultSet>

open suspend override fun fetchAll(sql: String): Result<ResultSet>

open suspend override fun <T> fetchAll(statement: Statement, rowMapper: RowMapper<T>): Result<List<T>>

listen

open suspend override fun listen(channel: String, f: (Notification) -> Unit)

Listens to a specific PostgreSQL channel and processes notifications using the provided callback function.

open suspend override fun listen(channels: List<String>, f: (Notification) -> Unit)

Listens to notifications on the specified PostgreSQL channels and processes them using the provided callback function. The notifications are received via the PostgreSQL listen/notify mechanism.

migrate

open suspend override fun migrate(path: String): Result<Unit>

notify

open suspend override fun notify(channel: String, value: String)

Sends a notification to a specific PostgreSQL channel with the given value.

poolIdleSize

open override fun poolIdleSize(): Int

poolSize

open override fun poolSize(): Int

transaction

open suspend fun <T> transaction(f: suspend Transaction.() -> T): T

validateChannelName

open fun validateChannelName(channel: String)

Validates the name of a PostgreSQL channel to ensure it adheres to the naming rules.